'\" te
.\" This manual page is derived from the DAT/uDAPL 1.2 specification.
.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH DAT_SRQ_RESIZE 3DAT "Jul 16, 2004"
.SH NAME
dat_srq_resize \- modify the size of the shared receive queue
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <\fBdat/udat.h\fR>

DAT_RETURN
    dat_srq_resize (
    IN      DAT_SRQ_HANDLE      srq_handle,
    IN      DAT_COUNT           srq_max_recv_dto
    )
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIsrq_handle\fR\fR
.ad
.RS 20n
A handle for an instance of the SRQ.
.RE

.sp
.ne 2
.na
\fB\fIsrq_max_recv_dto\fR\fR
.ad
.RS 20n
The new maximum number of Recv DTOs that Shared Receive Queue must hold.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBdat_srq_resize()\fR function modifies the size of the queue of SRQ.
.sp
.LP
Resizing of Shared Receive Queue should not cause any incoming messages on any
of the EPs that use the SRQ to be lost. If the number of outstanding Recv
buffers on the SRQ is larger then the requested \fIsrq_max_recv_dto\fR, the
operation returns \fBDAT_INVALID_STATE\fR and do not change SRQ. This includes
not just the buffers on the SRQ but all outstanding Receive buffers that had
been posted to the SRQ and whose completions have not reaped yet. Thus, the
outstanding buffers include the buffers on SRQ, the buffers posted to SRQ at
are at SRQ associated EPs, and the buffers posted to SRQ for which completions
have been generated but not yet reaped by Consumer from recv_evds of the EPs
that use the SRQ.
.sp
.LP
If the requested \fIsrq_max_recv_dto\fR is below the SRQ low watermark, the
operation returns \fBDAT_INVALID_STATE\fR and does not change SRQ.
.SH RETURN VALUES
.sp
.ne 2
.na
\fB\fBDAT_SUCCESS\fR\fR
.ad
.RS 30n
The operation was successful.
.RE

.sp
.ne 2
.na
\fB\fBDAT_INVALID_HANDLE\fR\fR
.ad
.RS 30n
The \fIsrq_handle\fR argument is an invalid DAT handle.
.RE

.sp
.ne 2
.na
\fB\fBDAT_INVALID_PARAMETER\fR\fR
.ad
.RS 30n
The \fIsrq_max_recv_dto\fR argument is invalid.
.RE

.sp
.ne 2
.na
\fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
.ad
.RS 30n
The operation failed due to resource limitations.
.RE

.sp
.ne 2
.na
\fB\fBDAT_INVALID_STATE\fR\fR
.ad
.RS 30n
Invalid state. Either the number of entries on the SRQ exceeds the requested
SRQ queue length or the requested SRQ queue length is smaller than the SRQ low
watermark.
.RE

.SH USAGE
.sp
.LP
The \fBdat_srq_resize()\fR function is required not to lose any buffers. Thus,
it cannot shrink below the outstanding number of Recv buffers on SRQ. There is
no requirement to shrink the SRQ to return \fBDAT_SUCCESS\fR.
.sp
.LP
The quality of the implementation determines how closely to the
Consumer-requested value the Provider shrinks the SRQ. For example, the
Provider can shrink the SRQ to the Consumer-requested value and if the
requested value is smaller than the outstanding buffers on SRQ, return
\fBDAT_INVALID_STATE\fR; or the Provider can shrink to some value larger than
that requested by the Consumer but below current SRQ size; or the Provider does
not change the SRQ size and still returns \fBDAT_SUCCESS\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard: uDAPL, 1.2
_
MT-Level	Unsafe
.TE

.SH SEE ALSO
.sp
.LP
.BR dat_srq_create (3DAT),
.BR dat_srq_free (3DAT),
.BR dat_srq_post_recv (3DAT),
.BR dat_srq_query (3DAT),
.BR dat_srq_set_lw (3DAT),
.BR libdat (3LIB),
.BR attributes (7)
